/*
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.1 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * The Original Code is iSQL-Viewer, A Mutli-Platform Database Tool.
 *
 * The Initial Developer of the Original Code is iSQL-Viewer, A Mutli-Platform Database Tool.
 * Portions created by Mark A. Kobold are Copyright (C) 2000-2007. All Rights Reserved.
 *
 * Contributor(s): 
 *  Mark A. Kobold [mkobold <at> isqlviewer <dot> com].
 *  
 * If you didn't download this code from the following link, you should check
 * if you aren't using an obsolete version: http://www.isqlviewer.com
 */
package org.isqlviewer.sql;

import java.sql.Connection;
import java.sql.SQLException;

/**
 * Native/Platform hook for providing registration information for iSQL-Viewer to the connection.
 * <p>
 * This is generally how the application identifies it's session with the database. For example with Oracle applications
 * will often update DBMS_APPLICATION_INFO setting various information identifying connections. However this allows
 * other platforms to be defined at a later date as I personally only know about how to do it with Oracle.
 * 
 * @author Mark A. Kobold &lt;mkobold at isqlviewer dot com&gt;
 * @version 1.0
 */
public interface PlatformRegistrar {

    /**
     * Registers this connection using platform specific things.
     * <p>
     * Please note that this connection is an unadulterated connection, it will not be an instance of the connection
     * wrapper that is defined by this package this is to allow type casting and so forth for easier registration.
     * 
     * @param nativeConnection to register iSQL-Viewer session to the underlying connection.
     * @return <tt>true</tt> if the registration succeeded, false otherwise not.
     * @throws SQLException if the registration fails as a result of registering the session.
     */
    public boolean register(Connection nativeConnection) throws SQLException;

}
